Locks a file.

OSErr PBHSetFLockSync (
    HParmBlkPtr paramBlock
);

Parameter descriptions

paramBlock

A pointer to a basic HFS parameter block.

function result

A result code.

DISCUSSION

The relevant fields of the parameter block are:

• ioCompletion

  On input, a pointer to a completion function.

• ioResult

  On output, the result code of the function.

• ioNamePtr

  On input, a pointer to a pathname for the file to lock.

• ioVRefNum

  On input, a volume specification for the volume on which the file is found.

• ioDirID

  On input, a directory ID.

After you lock a file, all new access paths to that file are read-only. Access paths currently in use aren’t affected.

If the PBHGetVolParmsSync function indicates that the volume supports folder locking (that is, the bHasFolderLock bit of the vMAttrib field is set), you can use PBHSetFLockSync to lock a directory.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)